API Documentation
Public Member Functions | List of all members
nkGraphics::ClearTargetsPass Class Reference

A clear target pass, during which some targets are cleared. More...

Inheritance diagram for nkGraphics::ClearTargetsPass:
nkGraphics::Pass nkGraphics::ProfilableClass nkExport::Exportable

Public Member Functions

bool getClearColor () const
 
bool getClearDepth () const
 
const float * getClearColorValues () const
 
float getClearColorValueR () const
 
float getClearColorValueG () const
 
float getClearColorValueB () const
 
float getClearColorValueA () const
 
unsigned int getTargetIndex () const
 
void setClearColor (bool value)
 
void setClearColorValues (float r, float g, float b, float a)
 
void setClearDepth (bool value)
 
void setTargetIndex (unsigned int value)
 
virtual void exportClassToTree (nkExport::Node *rootNode) override
 
virtual void importClassFromTree (nkExport::Node *rootNode) override
 
- Public Member Functions inherited from nkGraphics::Pass
TargetOperationsgetParentTargetOperations () const
 
PASS_TYPE getPassType () const
 
const char * getName () const
 
void setParentTargetOperations (TargetOperations *parent)
 
void setName (const char *name)
 
virtual void render ()=0
 
- Public Member Functions inherited from nkExport::Exportable
 Exportable ()
 
virtual ~Exportable ()
 

Detailed Description

A clear target pass, during which some targets are cleared.

During this operation, the targets selected are cleared using the settings of the pass.
See TargetOperations::addClearTargetsPass() to use it.

Member Function Documentation

◆ getClearColor()

bool nkGraphics::ClearTargetsPass::getClearColor ( ) const
Returns
Whether the color target should be cleared during this pass (true) or not (false).

◆ getClearDepth()

bool nkGraphics::ClearTargetsPass::getClearDepth ( ) const
Returns
Whether the depth target should be cleared during this pass (true) or not (false).

◆ getClearColorValues()

const float* nkGraphics::ClearTargetsPass::getClearColorValues ( ) const
Returns
The color values used for clearing the color target, as a 4 float array.

◆ getClearColorValueR()

float nkGraphics::ClearTargetsPass::getClearColorValueR ( ) const
Returns
The red component of the clear color value.

◆ getClearColorValueG()

float nkGraphics::ClearTargetsPass::getClearColorValueG ( ) const
Returns
The red component of the clear color value.

◆ getClearColorValueB()

float nkGraphics::ClearTargetsPass::getClearColorValueB ( ) const
Returns
The red component of the clear color value.

◆ getClearColorValueA()

float nkGraphics::ClearTargetsPass::getClearColorValueA ( ) const
Returns
The red component of the clear color value.

◆ getTargetIndex()

unsigned int nkGraphics::ClearTargetsPass::getTargetIndex ( ) const
Returns
In a multi target operations, the index of the color target cleared.

◆ setClearColor()

void nkGraphics::ClearTargetsPass::setClearColor ( bool  value)

Sets whether the color target should be cleared during the pass.

Parameters
valueIf the target should be cleared (true) or not (false).

◆ setClearColorValues()

void nkGraphics::ClearTargetsPass::setClearColorValues ( float  r,
float  g,
float  b,
float  a 
)

Sets the color to use when clearing a color target.

Parameters
rThe red component, between [0, 1].
gThe green component, between [0, 1].
bThe blue component, between [0, 1].
aThe alpha component, between [0, 1].

◆ setClearDepth()

void nkGraphics::ClearTargetsPass::setClearDepth ( bool  value)

Sets whether the depth target should be cleared during the pass.

Parameters
valueIf the target should be cleared (true) or not (false).

◆ setTargetIndex()

void nkGraphics::ClearTargetsPass::setTargetIndex ( unsigned int  value)

In a multi target operations, sets the index of the color target that should be cleared.

Parameters
valueThe index of the color target to clear.

◆ exportClassToTree()

virtual void nkGraphics::ClearTargetsPass::exportClassToTree ( nkExport::Node rootNode)
overridevirtual

Basic exporting capabilities.

Parameters
rootNodeThe tree to export to.

Reimplemented from nkGraphics::Pass.

◆ importClassFromTree()

virtual void nkGraphics::ClearTargetsPass::importClassFromTree ( nkExport::Node rootNode)
overridevirtual

Basic importing capabilities.

Parameters
rootNodeThe tree to import from.

Reimplemented from nkGraphics::Pass.


The documentation for this class was generated from the following file: